<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>PowerVR SDK</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<table width="100%">
  <tr>
    <td width="33%">
      <p align="left">&nbsp;<a href="http://www.imgtec.com"><img border="0" src="IMGLogo.jpg" width="200" height="30"></a></p>
    </td>
    <td width="33%">
      <p align="center"><font color="#808080" face="Arial" size="2">PowerVR Software Development Kit</a></font></p>
    </td>
    <td width="34%">
      <p align="right"><a href="http://www.powervr.com"><img border="0" src="PVRlogo.jpg" width="200" height="27"></a></p>
    </td>
  </tr>
</table>
<hr>
</head><body>
<!-- Generated by Doxygen 1.3.6 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
<h1>pvrengine::Option Class Reference</h1>A class to represent a single variable option in the options menu.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Option_8h-source.html">Option.h</a>&gt;</code>
<p>
Inheritance diagram for pvrengine::Option:<p><center><img src="classpvrengine_1_1Option__inherit__graph.png" border="0" usemap="#pvrengine_1_1Option__inherit__map" alt="Inheritance graph"></center>
<map name="pvrengine_1_1Option__inherit__map">
<area href="classpvrengine_1_1OptionEnum.html" shape="rect" coords="7,82,169,108" alt="">
<area href="classpvrengine_1_1OptionFloat.html" shape="rect" coords="193,82,351,108" alt="">
<area href="classpvrengine_1_1OptionInt.html" shape="rect" coords="375,82,519,108" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classpvrengine_1_1Option-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classpvrengine_1_1Option.html#a0">Option</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classpvrengine_1_1Option.html#a1">Option</a> (const CPVRTString &amp;strOption)</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classpvrengine_1_1Option.html#a2">~Option</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classpvrengine_1_1Option.html#a3">nextValue</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classpvrengine_1_1Option.html#a4">prevValue</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual CPVRTString&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classpvrengine_1_1Option.html#a5">getDisplayValue</a> ()</td></tr>

<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>CPVRTString&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classpvrengine_1_1Option.html#p0">m_strOption</a></td></tr>

<tr><td colspan=2><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>class&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classpvrengine_1_1Option.html#n0">OptionsMenu</a></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A class to represent a single variable option in the options menu. 
<p>
<dl compact><dt><b>Description:</b></dt><dd>A class to represent a single variable option in the options menu. </dd></dl>

<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="pvrengine::Option::Option" ></a><p>
<br><br><h3>Option</h3><br><div>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> pvrengine::Option::Option </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<dl compact><dt><b>Description:</b></dt><dd>blank constructor. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a1" doxytag="pvrengine::Option::Option" ></a><p>
<br><br><h3>Option</h3><br><div>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> pvrengine::Option::Option </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const CPVRTString &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>strOption</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<dl compact><dt><b>Inputs:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign=top><em>strOption</em>&nbsp;</td><td>name of option </td></tr>
  </table>
</dl>
<dl compact><dt><b>Description:</b></dt><dd>Base constructor just taking name of option. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a2" doxytag="pvrengine::Option::~Option" ></a><p>
<br><br><h3>~Option</h3><br><div>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual pvrengine::Option::~<a class="el" href="classpvrengine_1_1Option.html">Option</a> </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [inline, virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<dl compact><dt><b>Description:</b></dt><dd>destructor. </dd></dl>
    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a5" doxytag="pvrengine::Option::getDisplayValue" ></a><p>
<br><br><h3>getDisplayValue</h3><br><div>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual CPVRTString pvrengine::Option::getDisplayValue </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [inline, virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<dl compact><dt><b>Description:</b></dt><dd>retrieves a displayable version of the current value of this option </dd></dl>

<p>
Reimplemented in <a class="el" href="classpvrengine_1_1OptionEnum.html#a4">pvrengine::OptionEnum</a>, <a class="el" href="classpvrengine_1_1OptionInt.html#a4">pvrengine::OptionInt</a>, and <a class="el" href="classpvrengine_1_1OptionFloat.html#a4">pvrengine::OptionFloat</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a3" doxytag="pvrengine::Option::nextValue" ></a><p>
<br><br><h3>nextValue</h3><br><div>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual void pvrengine::Option::nextValue </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [inline, virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<dl compact><dt><b>Description:</b></dt><dd>sets the next value as current </dd></dl>

<p>
Reimplemented in <a class="el" href="classpvrengine_1_1OptionEnum.html#a1">pvrengine::OptionEnum</a>, <a class="el" href="classpvrengine_1_1OptionInt.html#a1">pvrengine::OptionInt</a>, and <a class="el" href="classpvrengine_1_1OptionFloat.html#a1">pvrengine::OptionFloat</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a4" doxytag="pvrengine::Option::prevValue" ></a><p>
<br><br><h3>prevValue</h3><br><div>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual void pvrengine::Option::prevValue </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [inline, virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<dl compact><dt><b>Description:</b></dt><dd>sets the previous value as current </dd></dl>

<p>
Reimplemented in <a class="el" href="classpvrengine_1_1OptionEnum.html#a2">pvrengine::OptionEnum</a>, <a class="el" href="classpvrengine_1_1OptionInt.html#a2">pvrengine::OptionInt</a>, and <a class="el" href="classpvrengine_1_1OptionFloat.html#a2">pvrengine::OptionFloat</a>.    </td>
  </tr>
</table>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="n0" doxytag="pvrengine::Option::OptionsMenu" ></a><p>
<br><br><h3>OptionsMenu</h3><br><div>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> friend class <a class="el" href="classpvrengine_1_1OptionsMenu.html">OptionsMenu</a><code> [friend]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="p0" doxytag="pvrengine::Option::m_strOption" ></a><p>
<br><br><h3>m_strOption</h3><br><div>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> CPVRTString <a class="el" href="classpvrengine_1_1Option.html#p0">pvrengine::Option::m_strOption</a><code> [protected]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Option_8h-source.html">Option.h</a></ul>
<br>
<br>
<P align=left><FONT size=2><STRONG><A 
   href="http://www.imgtec.com/powervr/insider/legal/index.asp">Copyright</A> � 
   1999-2008, Imagination Technologies Ltd.</STRONG></FONT></P>
<hr>
<address style="align: left;"><small><FONT color=f0f>
Generated by <a href="http://www.doxygen.org/index.html">DOXYGEN</a> 1.3.6</small></address>
</body>
</html>
